Totalflow – UIS Command Component Parameters

UIS Command Component Parameters

The following tables list and describe the parameters specific to the UIS command component types for this remote device:

For more general information about UIS command component parameters, see UIS Command Components. The DG_F_DEV (Get data group from device) and DG_T_DEV (Send data group to device) command component types are configured in the template file. The other command component types are considered ‘special’ and are defined in the EIE editor code. See Special UIS Command Component Types for more information.

CYUPDTPT

Update CygNet Point updates the record for a CygNet point. CYUPDTPT has the following command parameters:

Parameter	Required	Description
FOnErr	No	Fail cmd on update error indicates to abort the UIS command if any update errors are encountered. The errors that might come up include: if the point specified in the Fac, Serv, Site, or UDC parameters does not exist, or if the point exists in a different UIS and any messaging errors or communication failure to that service comes up.
Fac	Yes	Facility for pt identifies the facility of the point to update.
Serv	No	Service for pt identifies the SERVICE of the point to update.
Site	No	Site for pt identifies the SITE of the point to update.
UDC	Yes	UDC for pt identifies the UDC of the point to update.
UType	No	Update type indicates the type of update. Value options are 0 - 3, where 0=Completion, 1=Success, 2=Failure, 3=Creation.
UsrMsk	No	User bit mask specifies the user bit mask of the point to update.
UsrVal	No	User bit value to match specifies the user bit value to match when updating the point record.
Value	No	Value indicates the point value to update.

CYWAITPT

Wait for CygNet Point signals the UIS to wait to perform a command until the value of the specified CygNet point changes to a specified value.

CYWAITPT must be the first command component added to a UIS command. You cannot add other instances of CYWAITPT to a UIS command.

CYWAITPT has the following command parameters:

Parameter	Required	Description
Dur	Yes	Duration is the amount of time (in HH:MM:SS or HH:MM or HH) for the UIS command to wait for the point value to change before timing out.
FOnErr	No	Fail on point error indicates to abort the UIS command if any error conditions are encountered. The point errors that might come up include: if the point specified in the Fac, Serv, Site, or UDC parameters does not exist, or if the point exists in a different UIS and any messaging errors or communication failure to that service comes up.
Fac	Yes	Facility for pt identifies the facility of the point on which to wait for the point value to change before performing the UIS command.
Int	Yes	Interval indicates the frequency (in HH:MM:SS or HH:MM or HH) with which the UIS will check the point’s value to see if it has changed.
Serv	No	Service for pt identifies the SERVICE of the point on which to wait for the point value to change before performing the UIS command.
Site	No	Site for pt identifies the SITE of the point on which to wait for the point value to change before performing the UIS command.
UDC	Yes	UDC for pt identifies the UDC of the point on which to wait for the point value to change before performing the UIS command.
UsrMsk	No	User bit mask specifies the user bit mask on which to wait for the status bit change before issuing the UIS command. Note: The user status bit parameters (UsrMsk and UsrVal) only apply to the extended status field of the point record, so they will not match anything in the base status.
UsrVal	No	User bit value to match specifies the user bit value to match before issuing the UIS command.
Value	No	Value to match specifies the value on which to wait for the point to change to before issuing the UIS command. Note: You can set parameters for both the point user status AND point value. So you can match either one by itself, or you can specify that both must match your parameter values.

DG_F_DEV

Get data group from device retrieves a data group from a field device. The Parent XML Element is uccRecvParms. The following parameters are available for each specified data group type.

Data Group Type	Parameter	Required	Description
FmsAlarm	EDate	No	End Device Date/Time defines the ending device date and time of a date-range request. Value options are strings in formats described in Selecting Date and Time.
SDate	Yes	Start Date defines the starting date and time for a date-range request. Value options are strings in formats described in Selecting Date and Time.
FmsEvent	EDate	Yes	End Device Date/Time defines the ending device date and time of a date-range request. Value options are strings in formats described in Selecting Date and Time.
SDate	Yes	Start Date defines the starting date and time for a date-range request. Value options are strings in formats described in Selecting Date and Time.
FmsHistDGm	EDate	Yes	End Device Date/Time defines the ending device date and time of a date-range request. Value options are strings in formats described in Selecting Date and Time.
SDate	Yes	Start Date defines the starting date and time for a date-range request. Value options are strings in formats described in Selecting Date and Time.
FmsHistHGm	EDate	Yes	End Device Date/Time defines the ending device date and time of a date-range request. Value options are strings in formats described in Selecting Date and Time.
SDate	Yes	Start Date defines the starting date and time for a date-range request. Value options are strings in formats described in Selecting Date and Time.
FmsHistHGq	EDate	Yes	End Device Date/Time defines the ending device date and time of a date-range request. Value options are strings in formats described in Selecting Date and Time.
SDate	Yes	Start Date defines the starting date and time for a date-range request. Value options are strings in formats described in Selecting Date and Time.
HistDly	Day	No	Number of Days Back enables you to specify the number of days from which to collect historical data. Value options are integers from 0 to 40.
EDate	No	End Date/Time defines the ending date and time of a daily history date-range request. Value options are strings in formats described in Selecting Date and Time.
EITEM	No	End Seq# defines the last sequence number in the requested range. Value options are integers.
SDate	No	Start Date/Time defines the starting date and time of a daily history date-range request. Value options are strings in formats described in Selecting Date and Time.
SDateLast	No	Start from Last Date/Time retrieves history from the most recently cached history timestamp. Value options are Boolean.
SITEM	No	Start Seq# defines the first sequence number in the requested range. Value options are integers.
HistEvt	Day	No	Number of Days Back enables you to specify the number of days from which to collect historical data. Value options are integers. 0=range low, 40=range high.
EDate	No	End Date/Time defines the ending date and time of a daily history date-range request. Value options are strings in formats described in Selecting Date and Time.
EITEM	No	End Seq# defines the last sequence number in the requested range. Value options are integers.
SDate	No	Start Date/Time defines the starting date and time of a daily history date-range request. Value options are strings in formats described in Selecting Date and Time.
SDateLast	No	Start from Last Date/Time retrieves history from the most recently cached history timestamp. Value options are Boolean.
SITEM	No	Start Seq# defines the first sequence number in the requested range. Value options are integers.
HistGas	EDate	No	End Date/Time defines the ending date and time of a daily history date-range request. Value options are strings in formats described in Selecting Date and Time.
EITEM	No	End Seq# defines the last sequence number in the requested range. Value options are integers.
SDate	No	Start Date/Time defines the starting date and time of a daily history date-range request. Value options are strings in formats described in Selecting Date and Time.
SDateLast	No	Start from Last Date/Time retrieves history from the most recently cached history timestamp. Value options are Boolean.
SITEM	No	Start Seq# defines the first sequence number in the requested range. Value options are integers.
HistLog	Day	No	Number of Days Back enables you to specify the number of days from which to collect historical data. Value options are integers from 0 to 40.
EDate	No	End Date/Time defines the ending date and time of a daily history date-range request. Value options are strings in formats described in Selecting Date and Time.
EITEM	No	End Seq# defines the last sequence number in the requested range. Value options are integers.
SDate	No	Start Date/Time defines the starting date and time of a daily history date-range request. Value options are strings in formats described in Selecting Date and Time.
SDateLast	No	Start from Last Date/Time retrieves history from the most recently cached history timestamp. Value options are Boolean.
SITEM	No	Start Seq# defines the first sequence number in the requested range. Value options are integers.
TrendCfg	FileName	Yes	Trend File Name specifies the name of the trend file from which to retrieve data. Value options are strings.
TrendData	EDate	No	End Date/Time defines the ending date and time of a date-range request. Value options are strings in formats described in Selecting Date and Time.
EITEM	No	End Seq# defines the last sequence number in the requested range. Value options are integers.
SDate	No	Start Date/Time defines the starting date and time of a daily history date-range request. Value options are strings in formats described in Selecting Date and Time.
SDateLast	No	Start from Last Date/Time retrieves history from the most recently cached history timestamp. Value options are Boolean.
SITEM	No	Start Seq# defines the first sequence number in the requested range. Value options are integers.
TrendList	Folder	No	Trend Folder specifies the name of the trend folder from which to retrieve data. Value options are strings.

Data Group Type

Parameter

Required

Description

FmsAlarm

EDate

End Device Date/Time defines the ending device date and time of a date-range request.

Value options are strings in formats described in Selecting Date and Time.

SDate

Yes

Start Date defines the starting date and time for a date-range request.

Value options are strings in formats described in Selecting Date and Time.

FmsEvent

EDate

Yes

End Device Date/Time defines the ending device date and time of a date-range request.

Value options are strings in formats described in Selecting Date and Time.

SDate

Yes

Start Date defines the starting date and time for a date-range request.

Value options are strings in formats described in Selecting Date and Time.

FmsHistDGm

EDate

Yes

End Device Date/Time defines the ending device date and time of a date-range request.

Value options are strings in formats described in Selecting Date and Time.

SDate

Yes

Start Date defines the starting date and time for a date-range request.

Value options are strings in formats described in Selecting Date and Time.

FmsHistHGm

EDate

Yes

End Device Date/Time defines the ending device date and time of a date-range request.

Value options are strings in formats described in Selecting Date and Time.

SDate

Yes

Start Date defines the starting date and time for a date-range request.

Value options are strings in formats described in Selecting Date and Time.

FmsHistHGq

EDate

Yes

End Device Date/Time defines the ending device date and time of a date-range request.

Value options are strings in formats described in Selecting Date and Time.

SDate

Yes

Start Date defines the starting date and time for a date-range request.

Value options are strings in formats described in Selecting Date and Time.

HistDly

Day

Number of Days Back enables you to specify the number of days from which to collect historical data.

Value options are integers from 0 to 40.

EDate

End Date/Time defines the ending date and time of a daily history date-range request.

Value options are strings in formats described in Selecting Date and Time.

EITEM

End Seq# defines the last sequence number in the requested range.

Value options are integers.

SDate

Start Date/Time defines the starting date and time of a daily history date-range request.

Value options are strings in formats described in Selecting Date and Time.

SDateLast

Start from Last Date/Time retrieves history from the most recently cached history timestamp.

Value options are Boolean.

SITEM

Start Seq# defines the first sequence number in the requested range.

Value options are integers.

HistEvt

Day

Number of Days Back enables you to specify the number of days from which to collect historical data.

Value options are integers. 0=range low, 40=range high.

EDate

End Date/Time defines the ending date and time of a daily history date-range request.

Value options are strings in formats described in Selecting Date and Time.

EITEM

End Seq# defines the last sequence number in the requested range.

Value options are integers.

SDate

Start Date/Time defines the starting date and time of a daily history date-range request.

Value options are strings in formats described in Selecting Date and Time.

SDateLast

Start from Last Date/Time retrieves history from the most recently cached history timestamp.

Value options are Boolean.

SITEM

Start Seq# defines the first sequence number in the requested range.

Value options are integers.

HistGas

EDate

End Date/Time defines the ending date and time of a daily history date-range request.

Value options are strings in formats described in Selecting Date and Time.

EITEM

End Seq# defines the last sequence number in the requested range.

Value options are integers.

SDate

Start Date/Time defines the starting date and time of a daily history date-range request.

Value options are strings in formats described in Selecting Date and Time.

SDateLast

Start from Last Date/Time retrieves history from the most recently cached history timestamp.

Value options are Boolean.

SITEM

Start Seq# defines the first sequence number in the requested range.

Value options are integers.

HistLog

Day

Number of Days Back enables you to specify the number of days from which to collect historical data.

Value options are integers from 0 to 40.

EDate

End Date/Time defines the ending date and time of a daily history date-range request.

Value options are strings in formats described in Selecting Date and Time.

EITEM

End Seq# defines the last sequence number in the requested range.

Value options are integers.

SDate

Start Date/Time defines the starting date and time of a daily history date-range request.

Value options are strings in formats described in Selecting Date and Time.

SDateLast

Start from Last Date/Time retrieves history from the most recently cached history timestamp.

Value options are Boolean.

SITEM

Start Seq# defines the first sequence number in the requested range.

Value options are integers.

TrendCfg

FileName

Yes

Trend File Name specifies the name of the trend file from which to retrieve data.

Value options are strings.

TrendData

EDate

End Date/Time defines the ending date and time of a date-range request.

Value options are strings in formats described in Selecting Date and Time.

EITEM

End Seq# defines the last sequence number in the requested range.

Value options are integers.

SDate

Start Date/Time defines the starting date and time of a daily history date-range request.

Value options are strings in formats described in Selecting Date and Time.

SDateLast

Start from Last Date/Time retrieves history from the most recently cached history timestamp.

Value options are Boolean.

SITEM

Start Seq# defines the first sequence number in the requested range.

Value options are integers.

TrendList

Folder

Trend Folder specifies the name of the trend folder from which to retrieve data.

Value options are strings.

DG_T_DEV

Send data group to device sends a data group to a field device. The parent XML Element is uccSendParms. The following parameters are available for each specified data group type.

Data Group Type	Parameter	Required	Description
CmdMsg	CommandId	Yes	Command ID defines the Command Action (CA) to be enacted by the "Command Message" (CmdMsg) data group. Value options are as follows: 0: Turn Well On 1: Force Well Into Idle Time 2: Clear Errors 3: Force Off Until Reset
PlnCmd	BlowClose	-	Blow Valve Close sends a close valve command to the device. Value options are Boolean.
CaptClose	-	Capture Close Manual Value options are Boolean.
CaptOpen	-	Capture Open Manual Value options are Boolean.
EndFlwcyc	-	End Flow Cycle Value options are Boolean.
MainClose	-	Main Close Now Value options are Boolean.
MainClose	-	Main Valve Close sends a close valve command to the device. Value options are Boolean.
MainOpen	-	Main Valve Open sends an open valve command to the device. Value options are Boolean.
RstCtrl	-	Reset Controller Value options are Boolean.
RstDef	-	Reset Values to Default Value options are Boolean.
RstPlgrCtr	-	Reset Plunger Counters Value options are Boolean.
RstVcb	-	Reset VCBs (register addresses) Value options are Boolean.
StFlwcyc	-	Start Flow Cycle Value options are Boolean.
ValvClose	-	Main Valve Open sends a close valve command to the device. Value options are Boolean.
ValvOpen	-	Blow Valve Open sends an open valve command to the device. Value options are Boolean.
PlnCnfBas	AfFlTmLim	-	After Flow Time Value options are strings.
ClsTmLim	-	Off Time Value options are strings.
FallDlyEn	-	Fall Delay Enable (1=enabled) Value options are integers.
FallDlyTm	-	Fall Delay Time Value options are strings.
FlCyTmLim	-	On Time Value options are strings.
HldOnceAc	-	Hold Once Action Value options are integers.
HldOnceEn	-	Hold Once (0 or 4) Value options are integers.
HldOnceTm	-	Hold Once Time Value options are strings.
OAftFloTC1	-	Option After Flow Enable (1=enabled) Value options are integers.
ORecTimO	-	Mandatory Shut-in Time (1, 2, or 3) Value options are integers.
OTotalCyc	-	Sync Off/On (0 or 2) Value options are integers.
RecTimLim	-	Mandatory Recovery Time limit Value options are strings.
TF464	-	Plunger Control # Value options are integers.
PlnCtl	MainVlvCls	No	End Flow Cycle Value options are integers from 0 to 1.
MainVlvOpn	No	Start Flow Cycle Value options are integers from 0 to 1.
PlnCtlNum	No	Plunger Control Value options are integers from 0 to 2.
RstPlgrCtr	No	Reset Plunger Counters Value options are integers from 0 to 1.

Data Group Type

Parameter

Required

Description

CmdMsg

CommandId

Yes

Command ID defines the Command Action (CA) to be enacted by the "Command Message" (CmdMsg) data group.

Value options are as follows:

0: Turn Well On
1: Force Well Into Idle Time
2: Clear Errors
3: Force Off Until Reset

PlnCmd

BlowClose

Blow Valve Close sends a close valve command to the device.

Value options are Boolean.

CaptClose

Capture Close Manual

Value options are Boolean.

CaptOpen

Capture Open Manual

Value options are Boolean.

EndFlwcyc

End Flow Cycle

Value options are Boolean.

MainClose

Main Close Now

Value options are Boolean.

MainClose

Main Valve Close sends a close valve command to the device.

Value options are Boolean.

MainOpen

Main Valve Open sends an open valve command to the device.

Value options are Boolean.

RstCtrl

Reset Controller

Value options are Boolean.

RstDef

Reset Values to Default

Value options are Boolean.

RstPlgrCtr

Reset Plunger Counters

Value options are Boolean.

RstVcb

Reset VCBs (register addresses)

Value options are Boolean.

StFlwcyc

Start Flow Cycle

Value options are Boolean.

ValvClose

Main Valve Open sends a close valve command to the device.

Value options are Boolean.

ValvOpen

Blow Valve Open sends an open valve command to the device.

Value options are Boolean.

PlnCnfBas

AfFlTmLim

After Flow Time

Value options are strings.

ClsTmLim

Off Time

Value options are strings.

FallDlyEn

Fall Delay Enable (1=enabled)

Value options are integers.

FallDlyTm

Fall Delay Time

Value options are strings.

FlCyTmLim

On Time

Value options are strings.

HldOnceAc

Hold Once Action

Value options are integers.

HldOnceEn

Hold Once (0 or 4)

Value options are integers.

HldOnceTm

Hold Once Time

Value options are strings.

OAftFloTC1

Option After Flow Enable (1=enabled)

Value options are integers.

ORecTimO

Mandatory Shut-in Time (1, 2, or 3)

Value options are integers.

OTotalCyc

Sync Off/On (0 or 2)

Value options are integers.

RecTimLim

Mandatory Recovery Time limit

Value options are strings.

TF464

Plunger Control #

Value options are integers.

PlnCtl

MainVlvCls

End Flow Cycle

Value options are integers from 0 to 1.

MainVlvOpn

Start Flow Cycle

Value options are integers from 0 to 1.

PlnCtlNum

Plunger Control

Value options are integers from 0 to 2.

RstPlgrCtr

Reset Plunger Counters

Value options are integers from 0 to 1.